/*
 * Copyright (C) 2007 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.common.collect.testing.testers;

import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
import static com.google.common.collect.testing.features.CollectionSize.ZERO;

import com.google.common.annotations.GwtCompatible;
import com.google.common.annotations.GwtIncompatible;
import com.google.common.collect.testing.Helpers;
import com.google.common.collect.testing.features.CollectionFeature;
import com.google.common.collect.testing.features.CollectionSize;

import java.lang.reflect.Method;
import java.util.List;

import org.junit.Ignore;

/**
 * A generic JUnit test which tests {@code add(Object)} operations on a list. Can't be invoked
 * directly; please see {@link com.google.common.collect.testing.ListTestSuiteBuilder}.
 *
 * @author Chris Povirk
 */
@SuppressWarnings("unchecked") // too many "unchecked generic array creations"
@GwtCompatible(emulated = true)
@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
public class ListAddTester<E> extends AbstractListTester<E>
{
    @CollectionFeature.Require(SUPPORTS_ADD)
    @CollectionSize.Require(absent = ZERO)
    public void testAdd_supportedPresent()
    {
        assertTrue("add(present) should return true", getList().add(e0()));
        expectAdded(e0());
    }

    @CollectionFeature.Require(absent = SUPPORTS_ADD)
    @CollectionSize.Require(absent = ZERO)
    /*
     * absent = ZERO isn't required, since unmodList.add() must
     * throw regardless, but it keeps the method name accurate.
     */
    public void testAdd_unsupportedPresent()
    {
        try
        {
            getList().add(e0());
            fail("add(present) should throw");
        }
        catch (UnsupportedOperationException expected)
        {
        }
    }

    @CollectionFeature.Require(value = {SUPPORTS_ADD, ALLOWS_NULL_VALUES})
    @CollectionSize.Require(absent = ZERO)
    public void testAdd_supportedNullPresent()
    {
        E[] array = createArrayWithNullElement();
        collection = getSubjectGenerator().create(array);
        assertTrue("add(nullPresent) should return true", getList().add(null));

        List<E> expected = Helpers.copyToList(array);
        expected.add(null);
        expectContents(expected);
    }

    /**
     * Returns the {@link Method} instance for {@link #testAdd_supportedNullPresent()} so that tests
     * can suppress it. See {@link CollectionAddTester#getAddNullSupportedMethod()} for details.
     */
    @GwtIncompatible // reflection
    public static Method getAddSupportedNullPresentMethod()
    {
        return Helpers.getMethod(ListAddTester.class, "testAdd_supportedNullPresent");
    }
}
